Package com.cisco.pt.ipc.sim.impl
Class UserTrafficImpl
java.lang.Object
com.cisco.pt.ipc.impl.IPCObjectImpl
com.cisco.pt.ipc.sim.impl.UserTrafficImpl
- All Implemented Interfaces:
IPCObject,UserTraffic
Information provided by the PKI file:
\class UserTraffic
\brief UserTraffic represents the user traffic information (PDU).
\example appWindow().getActiveFile().getMainSimulation().getFrameInstanceAt(0).getTrafficSource()
- Author:
- Auto-generated
-
Field Summary
Fields inherited from class com.cisco.pt.ipc.impl.IPCObjectImpl
accessMessage, ipcFactory, packetTracerSession -
Constructor Summary
ConstructorsConstructorDescriptionUserTrafficImpl(IPCFactory ipcFactory, PacketTracerSession packetTracerSession, IPCMessageLTV accessMessage) -
Method Summary
Modifier and TypeMethodDescriptionInformation provided by the PKI file:Information provided by the PKI file:Information provided by the PKI file:getPdu()Information provided by the PKI file:intInformation provided by the PKI file:intInformation provided by the PKI file:Information provided by the PKI file:Information provided by the PKI file:Information provided by the PKI file:Information provided by the PKI file:intInformation provided by the PKI file:Information provided by the PKI file:Methods inherited from class com.cisco.pt.ipc.impl.IPCObjectImpl
getAccessMessage, getClassName, getFactory, getObjectUUID, getPacketTracerSession, sendMessage, sendMessageWithReturn, translateToCommandStatusStringPairMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.cisco.pt.ipc.IPCObject
getAccessMessage, getClassName, getFactory, getObjectUUID, getPacketTracerSession
-
Constructor Details
-
UserTrafficImpl
public UserTrafficImpl(IPCFactory ipcFactory, PacketTracerSession packetTracerSession, IPCMessageLTV accessMessage)
-
-
Method Details
-
getTrafficColorCode
public int getTrafficColorCode()Information provided by the PKI file:
\brief Returns the color code of this PDU. \return int, the color code of this PDU.- Specified by:
getTrafficColorCodein interfaceUserTraffic- Returns:
- int Returns a int
-
getTrafficTypeString
Information provided by the PKI file:
\brief Returns the traffic type of this PDU. \return QString, the traffic type of this PDU.- Specified by:
getTrafficTypeStringin interfaceUserTraffic- Returns:
- String Returns a String
-
getSourceDevice
Information provided by the PKI file:
\brief Returns the source device of this PDU. \return Device, the Device object of the source device of this PDU.- Specified by:
getSourceDevicein interfaceUserTraffic- Returns:
- Device Returns a Device
-
getDestinationDevice
Information provided by the PKI file:
\brief Returns the destination device of this PDU. \return Device, the Device object of the destination device of this PDU.- Specified by:
getDestinationDevicein interfaceUserTraffic- Returns:
- Device Returns a Device
-
getPdu
Information provided by the PKI file:
\brief Returns the PDU object of this PDU. \return PDU, the PDU object of this PDU.- Specified by:
getPduin interfaceUserTraffic- Returns:
- Pdu Returns a Pdu
-
getSendPort
Information provided by the PKI file:
\brief Returns the sending port of this PDU. \return Port, the Port object of the sending port of this PDU.- Specified by:
getSendPortin interfaceUserTraffic- Returns:
- Port Returns a Port
-
getCanonicalSource
Information provided by the PKI file:
\brief Returns the name of the source of this PDU. \return QString, the name of the source of this PDU.- Specified by:
getCanonicalSourcein interfaceUserTraffic- Returns:
- String Returns a String
-
getCanonicalDestination
Information provided by the PKI file:
\brief Returns the name of the destination of this PDU. \return QString, the name of the destination of this PDU.- Specified by:
getCanonicalDestinationin interfaceUserTraffic- Returns:
- String Returns a String
-
getStatus
Information provided by the PKI file:
\brief Returns the status of this PDU. \return TrafficStatus, the status of this PDU. Traffic statuses: eTrafficNotSend = 0, eTrafficInProgress = 1, eTrafficFailed = 2, eTrafficSuccessful = 3- Specified by:
getStatusin interfaceUserTraffic- Returns:
- TrafficStatus Returns a TrafficStatus
-
getTestCondition
Information provided by the PKI file:
\brief Returns the connectivity test status of this PDU. \return TrafficStatus, the the test condition status of this PDU. Traffic statuses: eTrafficNotSend = 0, eTrafficInProgress = 1, eTrafficFailed = 2, eTrafficSuccessful = 3- Specified by:
getTestConditionin interfaceUserTraffic- Returns:
- TrafficStatus Returns a TrafficStatus
-
getPoints
public int getPoints()Information provided by the PKI file:
\brief Returns the point value of this PDU. \return int, the point value of this PDU.- Specified by:
getPointsin interfaceUserTraffic- Returns:
- int Returns a int
-
getPduSize
public int getPduSize()Information provided by the PKI file:
\brief Returns the size of this PDU. \return int, the size of this PDU.- Specified by:
getPduSizein interfaceUserTraffic- Returns:
- int Returns a int
-